Number Manipulation Parameters

The number manipulation parameters are described in the table below.

Number Manipulation Parameters

Parameter

Description

configure voip > gateway manipulation settings > map-ip-to-pstn-refer-to

[ManipulateIP2PSTNReferTo]

Enables the manipulation of the called party (destination) number according to the SIP Refer-To header received by the device for TDM (PSTN) blind transfer. The number in the SIP Refer-To header is manipulated for all types of blind transfers to the PSTN (TBCT, ECT, RLT, and QSIG ).

[0] = Disable (default)
[1] = Enable

During the blind transfer, the device initiates a new call to the PSTN and the destination number of this call can be manipulated if the parameter is enabled. When enabled, the manipulation is done as follows:

1. If you configure a value for the xferPrefix parameter, the value (string) is added as a prefix to the number in the Refer-To header.
2. This called party number is then manipulated using the Destination Phone Number Manipulation for IP-to-Tel Calls table. The source number of the transferred call is taken from the original call, according to its initial direction:
Source number of the original call if it is a Tel-to-IP call
Destination number of the original call if it is an IP-to-Tel call

This source number can also be used as the value for the 'Source Phone Pattern' field in the Destination Phone Number Manipulation for IP-to-Tel Calls table. The local IP address is used as the value for the 'Source IP Address' field.

Note:

This manipulation doesn't affect IP-to-Trunk Group routing rules.

'Use Endpoint Number as Calling Number Tel-to-IP'

configure voip > gateway digital settings > epn-as-cpn-tel2ip

[UseEPNumAsCallingNumTel2IP]

Enables the use of the B-channel number as the calling number (sent in the From field of the INVITE) instead of the number received in the Q.931 Setup message, for Tel-to-IP calls.

[0] Disable (default)
[1] Enable

For example, if the incoming calling party number in the Q.931 Setup message is "12345" and the B-channel number is 17, then the outgoing INVITE From header is set to "17" instead of "12345".

Note:

When enabled, this feature is applied before routing and manipulation on the source number.

'Use Endpoint Number as Calling Number IP-to-Tel'

configure voip > gateway digital settings > epn-as-cpn-ip2tel

[UseEPNumAsCallingNumIP2Tel]

Enables the use of the B-channel number as the calling party number (sent in the Q.931 Setup message) instead of the number received in the From header of the INVITE, for IP-to-Tel calls.

[0] Disable (default)
[1] Enable

For example, if the incoming INVITE From header contains "12345" and the destined B-channel number is 17, then the outgoing calling party number in the Q.931 Setup message is set to "17" instead of "12345".

Note:

When enabled, this feature is applied after routing and manipulation on the source number (i.e., just before sending to the Tel side).

'Tel2IP Default Redirect Reason'

configure voip > gateway manipulation settings > tel-to-ip-dflt-redir-rsn

[Tel2IPDefaultRedirectReason]

Determines the default redirect reason for Tel-to-IP calls when no redirect reason (or “unknown”) exists in the received Q931 ISDN Setup message. The device includes this default redirect reason in the SIP History-Info header of the outgoing INVITE.

If a redirect reason exists in the received Setup message, the parameter is ignored and the device sends the INVITE message with the reason according to the received Setup message. If the parameter is not configured (-1), the outgoing INVITE is sent with the redirect reason as received in the Setup message (if none or “unknown” reason, then without a reason).

[-1] Not Configured = (Default) Received redirect reason is not changed
[1] Busy = Call forwarding busy
[2] No Reply = Call forwarding no reply
[9] DTE Out of Order = Call forwarding DTE out of order
[10] Deflection = Call deflection
[15] Systematic/Unconditional = Call forward unconditional

'Redirect Number IP-to-Tel'

configure voip > gateway routing settings > redir-nb-si-2tel

[SetIp2TelRedirectScreeningInd]

Defines the value of the Redirect Number screening indicator in ISDN Setup messages.

[-1] Not Configured (default)
[0] User Provided
[1] User Passed
[2] User Failed
[3] Network Provided

'Set IP-to-Tel Redirect Reason'

configure voip > gateway manipulation settings > ip2tel-redir-reason

[SetIp2TelRedirectReason]

Defines the redirect reason for IP-to-Tel calls. If redirect (diversion) information is received from the IP, the redirect reason is set to the value of the parameter before the device sends it on to the Tel.

[-1] Not Configured (default)
[0] Unkown
[1] Busy
[2] No Reply
[3] Network Busy
[4] Deflection
[9] DTE out of Order
[10] Forwarding DTE
[13] Transfer
[14] PickUp
[15] Systematic/Unconditional

'Set Tel-to-IP Redirect Reason'

configure voip > gateway manipulation settings > tel2ip-redir-reason

[SetTel2IpRedirectReason]

Defines the redirect reason for Tel-to-IP calls. If redirect (diversion) information is received from the Tel, the redirect reason is set to the value of the parameter before the device sends it on to the IP.

[-1] Not Configured (default)
[0] Unkown
[1] Busy
[2] No Reply
[3] Network Busy
[4] Deflection
[9] DTE out of Order
[10] Forwarding DTE
[13] Transfer
[14] PickUp
[15] Systematic/Unconditional

'Send Screening Indicator to IP'

configure voip > gateway digital settings > send-screen-to-ip

[ScreeningInd2IP]

Overrides the calling party's number (CPN) screening indication in the received ISDN SETUP message for Tel-to-IP calls.

[-1] Not Configured = (Default) Not configured (interworking from ISDN to IP).
[0] User Provided = CPN set by user, but not screened (verified).
[1] User Passed = CPN set by user, verified and passed.
[2] User Failed = CPN set by user, and verification failed.
[3] Network Provided = CPN set by network.

Note:

The parameter is applicable only if the Remote Party ID (RPID) header is enabled.

'Send Screening Indicator to ISDN'

configure voip > gateway digital settings > send-screen-to-isdn

[ScreeningInd2ISDN]

Defines (overrides) the screening indicator of the calling party's number in the ISDN Setup message for IP-to-Tel ISDN calls. This is applicable only when the device includes one calling party number in the outgoing ISDN Setup message.

[-1] Not Configured = (Default) Not configured (interworking from IP to ISDN).
[0] User Provided = Screening indicator is set to "user provided, not screened".
[1] User Passed = Screening indicator is set to "user provided, verified and passed".
[2] User Failed = Screening indicator is set to "user provided, verified and failed".
[3] Network Provided = Screening indicator is set to "network provided".
If the device includes two calling party numbers in the outgoing ISDN Setup message, this parameter is ignored and the screening indicator of the first and second calling party numbers are configured by the [ScreeningInd2ISDN1] and [ScreeningInd2ISDN2] parameters, respectively.

configure voip > gateway digital settings > send-screen-to-isdn-1

[ScreeningInd2ISDN1]

Defines (overrides) the screening indicator for the first calling party number when the device includes two calling party numbers in the outgoing ISDN Setup message for IP-to-Tel ISDN calls.

[-1] Not Configured = Not configured (interworking from IP to ISDN).
[0] User Provided = (Default) Screening indicator is set to "user provided, not screened".
[1] User Passed = Screening indicator is set to "user provided, verified and passed".
[2] User Failed = Screening indicator is set to "user provided, verified and failed".
[3] Network Provided = Screening indicator is set to "network provided".

Note:

If the device includes only one calling party number in the outgoing ISDN Setup message, the screening indicator is configured by the [ScreeningInd2ISDN] parameter.

configure voip > gateway digital settings > send-screen-to-isdn-2

[ScreeningInd2ISDN2]

Defines (overrides) the screening indicator for the second calling party number when the device includes two calling party numbers in the outgoing ISDN Setup message for IP-to-Tel ISDN calls.

[-1] Not Configured = Not configured (interworking from IP to ISDN).
[0] User Provided = Screening indicator is set to "user provided, not screened".
[1] User Passed = Screening indicator is set to "user provided, verified and passed".
[2] User Failed = Screening indicator is set to "user provided, verified and failed".
[3] Network Provided = (Default) Screening indicator is set to "network provided".

Note:

The SIP header in the incoming INVITE message from where the device obtains the second calling party number is configured by the [SecondCallingNumberSource] parameter.
If the device includes only one calling party number in the outgoing ISDN Setup message, the screening indicator is configured by the [ScreeningInd2ISDN] parameter.

'Copy Destination Number to Redirect Number'

configure voip > gateway digital settings > cp-dst-nb-2-redir-nb

[CopyDest2RedirectNumber]

Enables the device to copy the called number (from the received ISDN message for digital interfaces) to the outgoing SIP Diversion header for Tel-to-IP calls (even if a Redirecting Number IE is not received in the ISDN Setup message for digital interfaces). Therefore, the called number is used as a redirect number. Call redirection information is typically used for Unified Messaging and voice mail services to identify the recipient of a message.

[0] Don't copy = (Default) Disable.
[1] Copy after phone number manipulation = Copies the called number after manipulation. The device first performs Tel-to-IP destination phone number manipulation (i.e., on the SIP To header), and only then copies the manipulated called number to the SIP Diversion header for the Tel-to-IP call. Therefore, with this option, the called and redirect numbers are identical.
[2] Copy before phone number manipulation = Copies the called number before manipulation. The device first copies the original called number to the SIP Diversion header, and then performs Tel-to-IP destination phone number manipulation. Therefore, this allows you to have different numbers for the called (i.e., SIP To header) and redirect (i.e., SIP Diversion header) numbers.
If the incoming ISDN-to-IP call includes a Redirect Number, this number is overridden by the new called number if the parameter is set to [1] or [2].
You can also use this feature for IP-to-Tel calls, by configuring the parameter per IP Profile ('Copy Destination Number to Redirect Number'). For more information, see Configuring IP Profiles.

configure voip > sip-definition settings > rep-calling-w-redir

[ReplaceCallingWithRedirectNumber]

Enables the replacement of the calling number with the redirect number for ISDN-to-IP calls.

[0] = Disable (default)
[1] = The calling name is removed and left blank. The outgoing INVITE message excludes the redirect number that was used to replace the calling number. The replacement is done only if a redirect number is present in the incoming Tel call.
[2] = Manipulation is done on the new calling party number (after manipulation of the original calling party number, using the Tel2IPSourceNumberMappingDialPlanIndex parameter), but before the regular calling or redirect number manipulation:
If a redirect number exists, it replaces the calling party number. If there is no redirect number, the calling number is left unchanged.
If there is a calling “display” name, it remains unchanged.
The redirect number remains unchanged and is included in the SIP Diversion header.

'Add Trunk Group ID as Prefix'

configure voip > gateway routing settings > trkgrpid-prefix

[AddTrunkGroupAsPrefix]

Determines whether the Trunk Group ID is added as a prefix to the destination phone number (i.e., called number) for Tel-to-IP calls.

[0] No = (Default) Don't add Trunk Group ID as prefix.
[1] Yes = Add Trunk Group ID as prefix to called number.

Note:

This option can be used to define various routing rules.
To use this feature, you must configure the Trunk Group IDs (see Configuring Trunk Groups).

'Add Trunk ID as Prefix'

configure voip > gateway routing settings > trk-id-as-prefix

[AddPortAsPrefix]

Defines if the slot number / port number / Trunk ID is added as a prefix to the called (destination) number for Tel-to-IP calls.

[0] No (Default)
[1] Yes

If enabled, the device adds the following prefix to the called phone number: slot number (a single digit in the range of 1 to 6) and port number/Trunk ID (single digit in the range 1 to 8). For example, for the first trunk/channel located in the first slot, the number "11" is added as the prefix.

This option can be used to define various routing rules.

'Add Trunk Group ID as Prefix to Source'

trkgrpid-pref2source

[AddTrunkGroupAsPrefixToSource]

Enables the device to add the Trunk ID (from where the call originated) as the prefix to the calling number (i.e. source number).

[0] No (default)
[1] Yes

'Replace Empty Destination with B-channel Phone Number'

configure voip > gateway routing settings > empty-dst-w-bch-nb

[ReplaceEmptyDstWithPortNumber]

Determines whether the internal channel number is used as the destination number if the called number is missing.

[0] No (default)
[1] Yes

Note:

The parameter is applicable only to Tel-to-IP calls and if the called number is missing.

[CopyDestOnEmptySource]

Determines whether the destination number is copied to the source number if no source number is present, for Tel-to-IP calls.

[0] = (Default) Source Number is left empty.
[1] = If the Source Number of a Tel-to-IP call is empty, the Destination Number is copied to the Source Number.

'Add NPI and TON to Calling Number'

configure voip > gateway routing settings > npi-n-ton-to-cng-nb

[AddNPIandTON2CallingNumber]

Determines whether the Numbering Plan Indicator (NPI) and Type of Numbering (TON) are added to the Calling Number for Tel-to-IP calls.

[0] No = (Default) Do not change the Calling Number.
[1] Yes = Add NPI and TON to the Calling Number ISDN Tel-to-IP call.

For example: After receiving a Calling Number of 555, NPI of 1, and TON of 3, the modified number becomes 13555. This number can later be used for manipulation and routing.

'Add NPI and TON to Called Number'

configure voip > gateway routing settings > npi-n-ton-to-cld-nb

[AddNPIandTON2CalledNumber]

Determines whether NPI and TON are added to the Called Number for Tel-to-IP calls.

[0] No = (Default) Do not change the Called Number.
[1] Yes = Add NPI and TON to the Called Number of ISDN Tel-to-IP call.

For example: After receiving a Called Number of 555, NPI of 1 and TON of 3, the modified number becomes 13555. This number can later be used for manipulation and routing.

'Add NPI and TON to Redirect Number'

configure voip > gateway digital settings > np-n-ton-2-redirnb

[AddNPIandTON2RedirectNumber]

Determines whether the NPI and TON values are added as the prefix to the Redirect number in INVITE messages' Diversion or History-Info headers, for ISDN Tel-to-IP calls.

[0] Yes (Default)
[1] No

'IP-to-Tel Remove Routing Table Prefix'

configure voip > gateway routing settings > ip2tel-rmv-rte-tbl

[RemovePrefix]

Determines whether or not the device removes the prefix, as configured in the IP-to-Tel Routing table (see Configuring IP-to-Tel Routing Rules) from the destination number for IP-to-Tel calls, before sending it to the Tel.

[0] No (default)
[1] Yes

For example: To route an incoming IP-to-Tel call with destination number "21100", the IP-to-Tel Routing table is scanned for a matching prefix. If such a prefix is found (e.g., "21"), then before the call is routed to the corresponding Trunk Group, the prefix "21" is removed from the original number, and therefore, only "100" remains.

Note:

The parameter is applicable only if number manipulation is performed after call routing for IP-to-Tel calls (i.e., RouteModeIP2Tel parameter is set to 0).
Similar operation (of removing the prefix) is also achieved by using the usual number manipulation rules.

'Swap Redirect and Called Numbers'

configure voip > gateway digital settings > swap-rdr-n-called-nb

[SwapRedirectNumber]

[0] No = (Default) Don't change numbers.
[1] Yes = Incoming ISDN call that includes a redirect number (sometimes referred to as 'original called number') uses the redirect number instead of the called number.

configure voip > gateway manipulation settings > use-refer-by-for-calling-num

[UseReferredByForCallingNumber]

Determines whether the device uses the number from the URI in the SIP Referred-By header as the calling number in the outgoing Q.931 Setup message, when SIP REFER messages are received.

[0] = (Default) No
[1] = Yes

Note:

The parameter is applicable to all ISDN (TBCT, RLT, ECT) blind call transfers (except for in-band) and when the device receives SIP REFER messages with a Referred-By header.
This manipulation is done before regular IP-to-Tel source number manipulation.

configure voip > gateway manipulation settings > swap-tel-to-ip-phone-num

[SwapTel2IPCalled&CallingNumbers]

Global parameter enabling the device to swap the calling and called numbers received from the Tel side (for Tel-to-IP calls).

You can also configure the feature per specific calls, using Tel Profiles ('Swap Tel To IP Phone Numbers' parameter). For a detailed description of the parameter and for configuring the feature in the Tel Profiles table, see Configuring Tel Profiles.

Note: If the feature is configured for a specific Tel Profile, the settings of the global parameter is ignored for calls associated with the Tel Profile.

'Add Prefix to Redirect Number'

configure voip > gateway digital settings > add-pref-to-redir-nb

[Prefix2RedirectNumber]

Defines a string prefix that is added to the Redirect number received from the Tel side. This prefix is added to the Redirect Number in the SIP Diversion header.

The valid range is an 8-character string. By default, no value is defined.

'Add Number Plan and Type to RPI Header'

np-n-type-to-rpi-hdr

[AddTON2RPI]

Determines whether the TON/PLAN parameters are included in the Remote-Party-ID (RPID) header.

[0] No
[1] Yes (default)

If the Remote-Party-ID header is enabled (EnableRPIHeader = 1) and AddTON2RPI = 1, it's possible to configure the calling and called number type and number plan using the Number Manipulation tables for Tel-to-IP calls.

'Source Manipulation Mode'

configure voip > gateway routing settings > src-manipulation

[SourceManipulationMode]

Determines the SIP headers containing the source number after manipulation:

[0] From and P-Asserted-Identity after Manipulation = (Default) The SIP From and P-Asserted-Identity headers contain the source number after manipulation.
[1] Only From after Manipulation = Only SIP From header contains the source number after manipulation, while the P-Asserted-Identity header contains the source number before manipulation.

configure voip > gateway manipulation settings > prfm-ip-to-tel-dst-map

[PerformAdditionalIP2TELDestinationManipulation]

Enables additional destination number manipulation for IP-to-Tel calls. The additional manipulation is done on the initially manipulated destination number, and this additional rule is also configured in the manipulation table (NumberMapIP2Tel parameter). This enables you to configure only a few manipulation rules for complex number manipulation requirements (that generally require many rules).

[0] = Disable (default)
[1] = Enable

configure voip > gateway manipulation settings > prfm-ip-to-tel-src-map

[PerformAdditionalIP2TELSourceManipulation]

Enables additional source number manipulation for IP-to-Tel calls. The additional manipulation is done on the initially manipulated source number, and this additional rule is also configured in the manipulation table (SourceNumberMapIP2Tel parameter). This enables you to configure only a few manipulation rules for complex number manipulation requirements (that generally require many rules).

[0] = Disable (default)
[1] = Enable

'Add Phone Context As Prefix'

configure voip > gateway manipulation settings > add-ph-cntxt-as-pref

[AddPhoneContextAsPrefix]

Determines whether the received Phone-Context parameter is added as a prefix to the outgoing called and calling numbers (in ISDN Setup messages for digital interfaces).

[0] Disable (default)
[1] Enable